mirror of
https://github.com/obhq/obliteration.git
synced 2024-11-26 20:50:22 +00:00
Updates documentation (#1132)
This commit is contained in:
parent
fe45c4a733
commit
584964d6ca
2
.github/workflows/ci-docs.yml
vendored
2
.github/workflows/ci-docs.yml
vendored
@ -11,7 +11,7 @@ jobs:
|
||||
- name: Install system packages
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y mkdocs-material
|
||||
sudo apt-get install -y mkdocs
|
||||
- name: Disable PEP 668
|
||||
run: pip config set global.break-system-packages true
|
||||
- name: Install Python packages
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 121 KiB |
BIN
docs/img/favicon.ico
Normal file
BIN
docs/img/favicon.ico
Normal file
Binary file not shown.
After Width: | Height: | Size: 264 KiB |
@ -8,10 +8,10 @@ In order to build Obliteration from source make sure you have the following prer
|
||||
- Make sure you install using `rustup`
|
||||
- On Linux your distro may provide a package for this
|
||||
- On macOS you can install from Homebrew
|
||||
- [CMake 3.21+](https://cmake.org/download)
|
||||
- On Windows make sure you have `Add CMake to the system PATH` selected when installing
|
||||
- [Python 3](https://www.python.org)
|
||||
- On Windows make sure you have `Add Python to PATH` selected when installing
|
||||
- On Linux it is likely your distro already provided a package for this
|
||||
- On macOS you can install from Homebrew
|
||||
- On macOS you can install latest version from Homebrew
|
||||
|
||||
## Windows
|
||||
|
||||
@ -19,15 +19,3 @@ In order to build Obliteration from source make sure you have the following prer
|
||||
- Rust installer should already install this for you so you should not need to install this manually
|
||||
- Community edition are free for open-source project
|
||||
- `Desktop development with C++` workload is required
|
||||
- [Ninja](https://ninja-build.org)
|
||||
- You can install from [Chocolatey](https://chocolatey.org/install) with `choco install ninja`
|
||||
- If you install via the other method make sure Ninja is added to `PATH` environment variable
|
||||
|
||||
## Linux
|
||||
|
||||
- GCC that supports C++17
|
||||
- GNU Make
|
||||
|
||||
## macOS
|
||||
|
||||
- Xcode Command Line Tools
|
||||
|
14
mkdocs.yml
14
mkdocs.yml
@ -1,20 +1,12 @@
|
||||
site_name: Obliteration Developer
|
||||
nav:
|
||||
- 'index.md'
|
||||
- 'Kernel APIs': 'https://dev.obliteration.net/crates/obkrnl'
|
||||
- 'Reference':
|
||||
- 'Kernel': 'https://dev.obliteration.net/crates/obkrnl'
|
||||
repo_url: https://github.com/obhq/obliteration
|
||||
repo_name: obhq/obliteration
|
||||
edit_uri: edit/main/docs/
|
||||
markdown_extensions:
|
||||
- mdx_truly_sane_lists
|
||||
theme:
|
||||
name: material
|
||||
favicon: images/logo.png
|
||||
logo: images/logo.png
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
features:
|
||||
- content.action.edit
|
||||
- navigation.tabs
|
||||
palette:
|
||||
scheme: slate
|
||||
name: readthedocs
|
||||
|
Loading…
Reference in New Issue
Block a user