diff --git a/README.md b/README.md index 543ab73..f597103 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,137 @@ -# fuzzy-robot + -A three-dimensional graphics library from scratch written in C++13 and accelerated with CUDA. + + +
+ +
+ + +## Getting Started + +### Prerequisites + +Before attempting to build this project, make sure you have [Simple DirectMedia Layer (SDL 2)](https://wiki.libsdl.org/SDL2/Installation), [GNU Make](https://www.gnu.org/software/make/), and [CMake](https://cmake.org) installed on your machine. + + +### Installation + +To get a local copy of the project up and running on your machine, follow these simple steps: + +1. Clone the project repository + + ```sh + git clone https://github.com/Kaweees/graphics.git + cd graphics + ``` + +2. Build and execute the project + ```sh + clear && cmake CMakeLists.txt && make && ./target/release/graphics + ``` + +## Usage + +### Keyboard Shortcuts + +To enter custom commands into nvim, you must first enter a specific keybind, which is called the leader, followed by the command keybind while in a specific editor mode. My prefix key is space. + +To refresh neovim and install new plugins, type leader + I (capital i, as in Install) while in normal mode. + + + + + + +## Project Structure ```sh -clear && cmake CMakeLists.txt && make && ./target/release/graphics +. +├── after/plugins/ - plugin-specific configurations +├── lua +│ ├── include - lua modules +│ │ ├── lazy.lua - packages installed by lazy.nvim +│ │ ├── remap.lua - keybinds and leader configuration +│ │ └── set.lua - miscellaneous settings +│ └── plugins +│ ├── spec1.lua +│ ├── ** +│ └── spec2.lua +├── init.lua - Entry point, loads all plugins and configurations +└── README.md - you are here ``` + +## License + +The source code for my website is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information. + + + + +[contributors-shield]: https://img.shields.io/github/contributors/Kaweees/graphics.svg?style=for-the-badge +[contributors-url]: https://github.com/Kaweees/graphics/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/Kaweees/graphics.svg?style=for-the-badge +[forks-url]: https://github.com/Kaweees/graphics/network/members +[stars-shield]: https://img.shields.io/github/stars/Kaweees/graphics.svg?style=for-the-badge +[stars-url]: https://github.com/Kaweees/graphics/stargazers + + + +[C++-shield]: https://img.shields.io/badge/C++-%23008080.svg?style=for-the-badge&logo=c%2B%2B&logoColor=004482&labelColor=222222&color=004482 +[C++-url]: https://isocpp.org/ +[CUDA-shield]: https://img.shields.io/badge/cuda-%23008080.svg?style=for-the-badge&logo=nVIDIA&logoColor=76B900&labelColor=222222&color=76B900 +[CUDA-url]: https://developer.nvidia.com/cuda-zone +[Apple-shield]: https://img.shields.io/badge/metal-%23008080.svg?style=for-the-badge&logo=apple&logoColor=white&labelColor=222222&color=white +[Apple-url]: https://developer.apple.com/metal/ +[github-actions-shield]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=2671E5&labelColor=222222&color=2671E5 +[github-actions-url]: https://github.com/features/actions diff --git a/assets/img/cpp.svg b/assets/img/cpp.svg new file mode 100644 index 0000000..4c4b964 --- /dev/null +++ b/assets/img/cpp.svg @@ -0,0 +1,25 @@ + + + +