Skip to content

Commit

Permalink
Adds build instructions (#1136)
Browse files Browse the repository at this point in the history
  • Loading branch information
ultimaweapon authored Nov 23, 2024
1 parent ddc26cd commit 59f4e1d
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Building

The first step is getting Obliteration source code from our [repository](https://github.com/obhq/obliteration). If you plan to make some contributions you need to fork our repository by clicking on Fork on the top right before proceed and all instructions after this need to be done on your forked repository instead of our repository.

Once ready click on Code button on the top right then copy the HTTPS URL from the popup (or SSH if you know how to use it). Then open a terminal (or Command Prompt) on the directory where you want to download the source code into. You can use `cd` command to change to the directory you want. Then run the following command:

```sh
git clone URL
```

Replace `URL` with the URL you have copied.

## Build

Change into the directory you just downloaded with `cd` and run the following command:

```sh
python3 build.py -r
```

Remove `-r` to disable optimization if you plan to make some contributions so the debugger will work properly. Build outputs will be placed in `dist` directory.
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ In order to build Obliteration from source make sure you have the following prer

## All platforms

- [Git](https://git-scm.com)
- On Windows make sure you have `Run Git from the Windows Command Prompt` selected when installing
- On Linux it is likely your distro already provided a package for this
- On macOS you can install from Homebrew
- [Rust on the latest stable channel](https://www.rust-lang.org/tools/install)
- Make sure you install using `rustup`
- On Linux your distro may provide a package for this
Expand All @@ -19,3 +23,5 @@ 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
- [Windows Terminal](https://aka.ms/terminal)
- You can use a classic `Command Prompt` but make sure you enable [ANSI escape sequences](https://stackoverflow.com/q/16755142/1829232)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
site_name: Obliteration Developer
nav:
- 'index.md'
- 'building.md'
- 'Reference':
- 'Kernel': 'https://dev.obliteration.net/crates/obkrnl'
repo_url: https://github.com/obhq/obliteration
Expand Down

0 comments on commit 59f4e1d

Please sign in to comment.