Voxel.Wiki is a website that is all about voxels: Values on regular grids in three-dimensional space!
This repository holds the contents of the website in the form of a Zola project.
Feel free to contribute! :)
- Fork the project.
- Clone the project:
git clone https://github.com/YOUR-USERNAME-HERE/voxel-wiki.github.io.git - Open a console/terminal in the cloned projects directory.
- Install Zola, such that it is on your
PATHor put it right in the projects directory.
(Zola is a single executable file, so there shouldn't be any issues with this. Else, open an issue!) - Run
zola serve. - Make your changes to the content.
- Check the life-preview in your browser.
- Repeat from 6 as long as you need.
- Push the changes to your fork.
- Create a pull-request.
- Wait for a maintainer to review your changes.
- ???
- PROFIT!
If you're a maintainer (eg: you are part of the voxel-wiki organisation), you may directly push changes, as long as they don't affect too many pages. In the latter case, it's a better idea to do it trough a pull-request or a separate branch.
By contributing to this repository, your submitted work will be perpetually licensed under the MIT-License. This is to prevent people from taking down content once submitted. If this seems unreasonable, please open an issue, as none of us are lawyers!
Copyright © 2021 - The voxel-wiki organisation.
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.