diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ff96153 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Joseph Ferano + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 445db63..765d19d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ topics; graphics, web, and functional programming. It uses Elm with WebGL to create a basic 3D first-person scene implementing several lower level graphics techniques including matrix transformations to model parent/child local transforms, texture mapping, and basic lighting with shaders. Consider it the -humble beginnings of a functional 3D graphics engine. +humble beginnings of a functional 3D graphics engine. The last major work done +on this was in 2019, however, it was just thrown into a git repo without much +consideration, along with other another small graphics project. Here's the +original [project](https://github.com/JosephFerano/elm-graphics) !["FPS Scene"](screenshots/elm-fps.png) @@ -27,12 +30,11 @@ This project is Elm 0.18.0, so you need to have that version installed. To install the binaries manually, use - [Install Binaries](https://sirfitz.medium.com/install-elm-0-18-0-in-2021-3f64ce298801) -If you want to use `npm`, you can follow this; +If you want to use `npm`, here's a quick guide; - [Install with npm](https://discourse.elm-lang.org/t/downgrade-to-v18/2005/2) Note that for `npm`, you will likely need an older version of Node.js, so it -is recommended to use the [Node Version Manager -`npm`](https://github.com/nvm-sh/nvm) for that. +is recommended to use the [`npm`](https://github.com/nvm-sh/nvm). ## Running @@ -66,3 +68,9 @@ an HTTP server, you can use the following; - Rotate Robot Hand: `U and J` +## License + +This project is licensed under the terms of the MIT license. For more +information, see the included LICENSE file. + +