Merge branch 'update_contributing_docs' into 'master'
Update github references to be gitlab references See merge request redox-os/redox!1196
This commit is contained in:
Jeremy Soller
commit
0c11463711
|
|
@ -65,14 +65,14 @@ News and updates for Redox are posted at [redox-os.org/news](https://redox-os.or
|
|||
|
||||
* Writing _documentation_
|
||||
* **Using/testing Redox**, filing issues for bugs and needed features
|
||||
* **Web development** ([Redox website, separate repo](https://github.com/redox-os/website))
|
||||
* **Web development** ([Redox website, separate repo](https://gitlab.redox-os.org/redox-os/website))
|
||||
* **Writing unit tests** (may require minimal knowledge of rust)
|
||||
|
||||
#### If you are fluent in Rust, but not OS Development:
|
||||
|
||||
* **Apps** development
|
||||
* **Shell** ([Ion](https://github.com/redox-os/ion)) development
|
||||
* **Package management** ([pkgutils](https://github.com/redox-os/pkgutils)) development
|
||||
* **Shell** ([Ion](https://gitlab.redox-os.org/redox-os/ion)) development
|
||||
* **Package management** ([pkgutils](https://gitlab.redox-os.org/redox-os/pkgutils)) development
|
||||
* Other high-level code tasks
|
||||
|
||||
#### If you are fluent in Rust, and have experience with OS Dev:
|
||||
|
|
@ -86,14 +86,14 @@ News and updates for Redox are posted at [redox-os.org/news](https://redox-os.or
|
|||
**1**. _**Fork**_ the repository
|
||||
|
||||
**2**. Clone the _original repository_ to your local PC using one of the following commands based on the protocol you are using:
|
||||
* HTTPS:`git clone https://github.com/redox-os/redox.git --origin upstream --recursive`
|
||||
* SSH:`git clone git@github.com:redox-os/redox.git --origin upstream --recursive`
|
||||
* HTTPS:`git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream --recursive`
|
||||
* SSH:`git clone git@gitlab.redox-os.org:redox-os/redox.git --origin upstream --recursive`
|
||||
* Then rebase: `git rebase upstream master`
|
||||
If you use HTTPS, you will have to log in each time when pushing to your fork. (Recommended: learn about git SSH support, it logs in automatically using SSH keys)
|
||||
|
||||
**3**. **Add** your fork with
|
||||
* HTTPS:`git remote add origin https://github.com/your-username/redox.git`
|
||||
* SSH:`git remote add origin git@github.com:your-username/redox.git`
|
||||
* HTTPS:`git remote add origin https://gitlab.redox-os.org/your-username/redox.git`
|
||||
* SSH:`git remote add origin git@gitlab.redox-os.org:your-username/redox.git`
|
||||
|
||||
**4**. Alternatively, if you already have a fork and copy of the repo, you can simply check to **make sure you're up-to-date**
|
||||
* Pull the upstream:`git pull upstream --rebase`
|
||||
|
|
@ -190,7 +190,7 @@ If you're a good designer, whether it's _2D graphics, 3D graphics, interfaces, w
|
|||
|
||||
### <a name="patreon"> Patreon </a>
|
||||
|
||||
Our **BDFL**, [jackpot51](https://github.com/jackpot51), has a [Patreon campaign](https://www.patreon.com/redox_os)! **All money received will go towards Redox OS development**. If you donate, you will be listed in the **Redox credits** as one of the people that made Redox OS possible. You'll also get other rewards the more you donate. However, please don't donate if you can't afford it.
|
||||
Our **BDFL**, [jackpot51](https://gitlab.redox-os.org/jackpot51), has a [Patreon campaign](https://www.patreon.com/redox_os)! **All money received will go towards Redox OS development**. If you donate, you will be listed in the **Redox credits** as one of the people that made Redox OS possible. You'll also get other rewards the more you donate. However, please don't donate if you can't afford it.
|
||||
|
||||
<!--
|
||||
|
||||
|
|
|
|||
26
README.md
26
README.md
|
|
@ -1,5 +1,5 @@
|
|||
<p align="center">
|
||||
<img alt="Redox" width="346" src="https://github.com/redox-os/assets/raw/master/logos/redox/logo.png">
|
||||
<img alt="Redox" width="346" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/logos/redox/logo.png">
|
||||
</p>
|
||||
|
||||
**Redox** is an operating system written in Rust, a language with focus on safety and high performance. Redox, following the microkernel design, aims to be secure, usable, and free. Redox is inspired by previous kernels and operating systems, such as SeL4, MINIX, Plan 9, and BSD.
|
||||
|
|
@ -11,7 +11,7 @@ The website can be found at https://www.redox-os.org.
|
|||
Please make sure you use the **latest nightly** of `rustc` before building (for more troubleshooting, see ["Help! Redox won't compile!"](#compile-help)).
|
||||
|
||||
[](https://travis-ci.org/redox-os/redox)
|
||||
[](https://github.com/redox-os/redox/releases)
|
||||
[](https://gitlab.redox-os.org/redox-os/redox/tags)
|
||||
[](./LICENSE)
|
||||
|
||||
|
||||
|
|
@ -28,13 +28,13 @@ Please make sure you use the **latest nightly** of `rustc` before building (for
|
|||
|
||||
## <a name="screenshots"> What it looks like </a>
|
||||
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/Senza%20titolo.jpeg">
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/redox running.jpeg">
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/IMG_1460.PNG">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Senza%20titolo.jpeg">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/redox running.jpeg">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1460.PNG">
|
||||
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/Sodium_v2.PNG">
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/Boot.png">
|
||||
<img alt="Redox" height="150" src="https://github.com/redox-os/assets/raw/master/screenshots/IMG_1459.PNG">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Sodium_v2.PNG">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Boot.png">
|
||||
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1459.PNG">
|
||||
|
||||
## <a name="ecosystem"> Ecosystem </a>
|
||||
|
||||
|
|
@ -78,12 +78,12 @@ The ecosystem and software Redox OS provides is listed below.
|
|||
Sometimes things go wrong when compiling. Try the following before opening an issue:
|
||||
|
||||
1. Make sure you have a Redox toolchain (`x86_64-unknown-redox-gcc`).
|
||||
* You can install from .deb packages (`https://static.redox-os.org/toolchain/apt/`) or build [redox-os/libc](https://github.com/redox-os/libc) manually.
|
||||
* You can install from .deb packages (`https://static.redox-os.org/toolchain/apt/`) or build [redox-os/libc](https://gitlab.redox-os.org/redox-os/libc) manually.
|
||||
1. Run `rustup update`
|
||||
1. Run `make clean pull`.
|
||||
1. Make sure you have **the latest version of Rust nightly!** ([rustup.rs](https://www.rustup.rs) is recommended for managing Rust versions. If you already have it, run `rustup`).
|
||||
1. Update **GNU Make**, **NASM** and **QEMU/VirtualBox**.
|
||||
1. Pull the upstream master branch (`git remote add upstream git@github.com:redox-os/redox.git; git pull upstream master`).
|
||||
1. Pull the upstream master branch (`git remote add upstream git@gitlab.redox-os.org:redox-os/redox.git; git pull upstream master`).
|
||||
1. Update submodules (`git submodule update --recursive --init`).
|
||||
|
||||
and then rebuild!
|
||||
|
|
@ -102,7 +102,7 @@ Redox is big, even compressed. Downloading the full history may take a lot of ba
|
|||
$ cd path/to/your/projects/folder/
|
||||
|
||||
# Run bootstrap setup
|
||||
$ curl -sf https://raw.githubusercontent.com/redox-os/redox/master/bootstrap.sh -o bootstrap.sh && bash -e bootstrap.sh
|
||||
$ curl -sf https://gitlab.redox-os.org/redox-os/redox/raw/master/bootstrap.sh -o bootstrap.sh && bash -e bootstrap.sh
|
||||
|
||||
# Change to project directory
|
||||
$ cd redox
|
||||
|
|
@ -127,9 +127,9 @@ To manually clone, build and run Redox using a Unix-based host, run the followin
|
|||
$ cd path/to/your/projects/folder/
|
||||
|
||||
# HTTPS
|
||||
$ git clone https://github.com/redox-os/redox.git --origin upstream --recursive
|
||||
$ git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream --recursive
|
||||
# SSH
|
||||
$ git clone git@github.com:redox-os/redox.git --origin upstream --recursive
|
||||
$ git clone git@gitlab.redox-os.org:redox-os/redox.git --origin upstream --recursive
|
||||
|
||||
$ cd redox/
|
||||
|
||||
|
|
|
|||
|
|
@ -450,7 +450,7 @@ statusCheck() {
|
|||
echo "******************************************************************"
|
||||
echo "The Travis build did not finish, this is an error with its config."
|
||||
echo "I cannot reliably determine whether the build is succeeding or not."
|
||||
echo "Consider checking for and maybe opening an issue on github"
|
||||
echo "Consider checking for and maybe opening an issue on gitlab"
|
||||
echo "******************************************************************"
|
||||
else
|
||||
echo
|
||||
|
|
@ -469,7 +469,7 @@ statusCheck() {
|
|||
###########################################################################
|
||||
boot()
|
||||
{
|
||||
echo "Cloning github repo..."
|
||||
echo "Cloning gitlab repo..."
|
||||
git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream --recursive
|
||||
rustInstall
|
||||
if [[ "`cargo install --list`" != *"xargo"* ]]; then
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ toolchain versions, you don't need to update the container.
|
|||
|
||||
### <a name='get_the_sources'></a>Get the sources
|
||||
```
|
||||
git clone https://github.com/redox-os/redox.git ; cd redox
|
||||
git clone https://gitlab.redox-os.org/redox-os/redox.git ; cd redox
|
||||
```
|
||||
|
||||
### Update the source tree
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
build/libkernel.a: kernel/Cargo.toml kernel/src/* kernel/src/*/* kernel/src/*/*/* kernel/src/*/*/*/* build/initfs.tag
|
||||
# Temporary fix for https://github.com/redox-os/redox/issues/963 allowing to build on macOS
|
||||
# Temporary fix for https://gitlab.redox-os.org/redox-os/redox/issues/963 allowing to build on macOS
|
||||
ifeq ($(UNAME),Darwin)
|
||||
cd kernel && CC=$(ARCH)-elf-gcc AR=$(ARCH)-elf-ar CFLAGS=-ffreestanding INITFS_FOLDER=$(ROOT)/build/initfs xargo rustc --lib --target $(KTARGET) --release -- -C soft-float -C debuginfo=2 --emit link=../$@
|
||||
else
|
||||
|
|
|
|||
Loading…
Reference in a new issue