Commit 35d236fc authored by Allen Mak's avatar Allen Mak Committed by deing

Basic README

parent 96dc2bb8
The contents of the wiki are released under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
By contributing content to the wiki, you agree to the distribution of it under that license.
By contributing content to the wiki, you agree to the distribution of it under that license.
\ No newline at end of file
# Unofficial Tildes Wiki
This is the repository for the the Unofficial Tildes Wiki
## Getting Started
Visit the Unofficial Tildes Wiki at https://unofficial-tildes-wiki.gitlab.io/
The archive of the previous Doku wiki hosted by Kat can be found at https://gitlab.com/unofficial-tildes-wiki/tildes-wiki-archive
See below for development instructions.
### Prerequisites
You will need [git](https://git-scm.com/downloads), [Pandoc](https://pandoc.org/installing.html), and [sassc](https://github.com/sass/sassc). Please take note that the programs install by your package manager may be out of date. Visit the links for the latest versions and installation instructions.
### Installing/Building
For Debian/Ubuntu:
1. Open a terminal
2. Install the prerequisites: `sudo apt-get install git pandoc sassc` - This will prompt for your __admin password__ in order to install new packages.
3. Clone the repository: `git clone https://gitlab.com/unofficial-tildes-wiki/unofficial-tildes-wiki.gitlab.io`
4. Go into the directory: `cd unofficial-tildes-wiki.gitlab.io`
5. Run the build script: `./build.sh`
You should now have deployable html files in the `public` directory.
## Contributing
Feel free to [open a new issue](https://gitlab.com/unofficial-tildes-wiki/unofficial-tildes-wiki.gitlab.io/issues/new) or [request access to the GitLab group](https://gitlab.com/groups/unofficial-tildes-wiki/-/group_members/request_access)!
## Authors
See the list of [contributors](https://gitlab.com/unofficial-tildes-wiki/unofficial-tildes-wiki.gitlab.io/project_members) who participated in this project.
## License
This project is licensed under the [Creative Commons Attribution 4.0 International License (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/legalcode) - see the [LICENSE.md](LICENSE.md) file for details
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment