Skip to content

Commit

Permalink
Updates documentation (#1132)
Browse files Browse the repository at this point in the history
  • Loading branch information
ultimaweapon authored Nov 22, 2024
1 parent fe45c4a commit 584964d
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file removed docs/images/logo.png
Binary file not shown.
Binary file added docs/img/favicon.ico
Binary file not shown.
18 changes: 3 additions & 15 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,14 @@ 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

- [Visual Studio 2022](https://visualstudio.microsoft.com/vs)
- 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 changes: 3 additions & 11 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 584964d

Please sign in to comment.