Rename organization rcore-os to arceos-org

README.md

@@ -1,8 +1,8 @@
 # ArceOS
 
-[![CI](https://github.com/rcore-os/arceos/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/rcore-os/arceos/actions/workflows/build.yml)
-[![CI](https://github.com/rcore-os/arceos/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/rcore-os/arceos/actions/workflows/test.yml)
-[![Docs](https://img.shields.io/badge/docs-pages-green)](https://rcore-os.github.io/arceos/)
+[![CI](https://github.com/arceos-org/arceos/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/arceos-org/arceos/actions/workflows/build.yml)
+[![CI](https://github.com/arceos-org/arceos/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/arceos-org/arceos/actions/workflows/test.yml)
+[![Docs](https://img.shields.io/badge/docs-pages-green)](https://arceos-org.github.io/arceos/)
 
 An experimental modular operating system (or unikernel) written in Rust.
 
@@ -192,6 +192,26 @@ make PLATFORM=aarch64-raspi4 A=apps/fs/shell FEATURES=driver-bcm2835-sdhci
 make PLATFORM=x86_64-pc-oslab A=apps/c/redis FEATURES=driver-ixgbe,driver-ramdisk SMP=4
 ```
 
+### How to reuse ArceOS crates/modules in your own project
+
+* For packages have been published to crates.io (listed in [doc/README.md](doc/README.md#crates)):
+
+    ```toml
+    # In Cargo.toml
+    [dependencies]
+    memory_addr = "0.1" # crates/memory_addr
+    crate_interface = "0.1"  # crates/crate_interface
+    ```
+
+* For packages not published to crates.io:
+
+    ```toml
+    # In Cargo.toml
+    [dependencies]
+    scheduler = { git = "https://github.com/arceos-org/arceos.git", tag = "0.1.0" } # crates/scheduler
+    axhal = { git = "https://github.com/arceos-org/arceos.git", tag = "0.1.0" } # modules/axhal
+    ```
+
 ## Design
 
 ![](doc/figures/ArceOS.svg)

api/arceos_api/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Public APIs and types for ArceOS modules"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/api/arceos_api"
-documentation = "https://rcore-os.github.io/arceos/arceos_api/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/api/arceos_api"
+documentation = "https://arceos-org.github.io/arceos/arceos_api/index.html"
 
 [features]
 default = []

api/arceos_api/src/lib.rs

@@ -1,6 +1,6 @@
 //! Public APIs and types for [ArceOS] modules
 //!
-//! [ArceOS]: https://github.com/rcore-os/arceos
+//! [ArceOS]: https://github.com/arceos-org/arceos
 
 #![no_std]
 #![feature(doc_auto_cfg)]

api/arceos_posix_api/Cargo.toml

@@ -11,8 +11,9 @@ authors = [
     "Shiping Yuan <[email protected]>",
 ]
 description = "POSIX-compatible APIs for ArceOS modules"
-license = "GPL-3.0-or-later OR Apache-2.0"
-repository = "https://github.com/rcore-os/arceos/tree/main/api/arceos_posix_api"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/api/arceos_posix_api"
 
 [features]
 default = []

api/arceos_posix_api/src/lib.rs

@@ -1,6 +1,6 @@
 //! POSIX-compatible APIs for [ArceOS] modules
 //!
-//! [ArceOS]: https://github.com/rcore-os/arceos
+//! [ArceOS]: https://github.com/arceos-org/arceos
 
 #![cfg_attr(all(not(test), not(doc)), no_std)]
 #![feature(doc_cfg)]

api/axfeat/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Top-level feature selection for ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/api/axfeat"
-documentation = "https://rcore-os.github.io/arceos/axfeat/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/api/axfeat"
+documentation = "https://arceos-org.github.io/arceos/axfeat/index.html"
 
 [features]
 default = []

api/axfeat/src/lib.rs

@@ -35,6 +35,6 @@
 //!     - `log-level-error`, `log-level-warn`, `log-level-info`, `log-level-debug`,
 //!       `log-level-trace`: Keep logging only at the specified level or higher.
 //!
-//! [ArceOS]: https://github.com/rcore-os/arceos
+//! [ArceOS]: https://github.com/arceos-org/arceos
 
 #![no_std]

apps/c/httpserver/httpserver.c

@@ -20,11 +20,11 @@ const char content[] = "<html>\n\
 </head>\n\
 <body>\n\
   <center>\n\
-    <h1>Hello, <a href=\"https://github.com/rcore-os/arceos\">ArceOS</a></h1>\n\
+    <h1>Hello, <a href=\"https://github.com/arceos-org/arceos\">ArceOS</a></h1>\n\
   </center>\n\
   <hr>\n\
   <center>\n\
-    <i>Powered by <a href=\"https://github.com/rcore-os/arceos/tree/main/apps/net/httpserver\">ArceOS example HTTP server</a> v0.1.0</i>\n\
+    <i>Powered by <a href=\"https://github.com/arceos-org/arceos/tree/main/apps/net/httpserver\">ArceOS example HTTP server</a> v0.1.0</i>\n\
   </center>\n\
 </body>\n\
 </html>\n\

apps/net/httpserver/src/main.rs

@@ -38,11 +38,11 @@ const CONTENT: &str = r#"<html>
 </head>
 <body>
   <center>
-    <h1>Hello, <a href="https://github.com/rcore-os/arceos">ArceOS</a></h1>
+    <h1>Hello, <a href="https://github.com/arceos-org/arceos">ArceOS</a></h1>
   </center>
   <hr>
   <center>
-    <i>Powered by <a href="https://github.com/rcore-os/arceos/tree/main/apps/net/httpserver">ArceOS example HTTP server</a> v0.1.0</i>
+    <i>Powered by <a href="https://github.com/arceos-org/arceos/tree/main/apps/net/httpserver">ArceOS example HTTP server</a> v0.1.0</i>
   </center>
 </body>
 </html>

crates/allocator/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Various allocator algorithms in a unified interface"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/allocator"
-documentation = "https://rcore-os.github.io/arceos/allocator/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/allocator"
+documentation = "https://arceos-org.github.io/arceos/allocator/index.html"
 
 [features]
 default = []

crates/arm_gic/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "ARM Generic Interrupt Controller (GIC) register definitions and basic operations"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/arm_gic"
-documentation = "https://rcore-os.github.io/arceos/arm_gic/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/arm_gic"
+documentation = "https://arceos-org.github.io/arceos/arm_gic/index.html"
 
 [dependencies]
 tock-registers = "0.8"

crates/arm_pl011/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "ARM Uart pl011 register definitions and basic operations"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/arm_pl011"
-documentation = "https://rcore-os.github.io/arceos/arm_pl011/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/arm_pl011"
+documentation = "https://arceos-org.github.io/arceos/arm_pl011/index.html"
 
 [dependencies]
 tock-registers = "0.8"

crates/axerrno/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Error code definition used by ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/axerrno"
-documentation = "https://rcore-os.github.io/arceos/axerrno/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/axerrno"
+documentation = "https://arceos-org.github.io/arceos/axerrno/index.html"
 
 [dependencies]
 log = "0.4"

crates/axerrno/src/lib.rs

@@ -1,4 +1,4 @@
-//! Error code definition used by [ArceOS](https://github.com/rcore-os/arceos).
+//! Error code definition used by [ArceOS](https://github.com/arceos-org/arceos).
 //!
 //! It provides two error types and the corresponding result types:
 //!

crates/axfs_devfs/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Device filesystem used by ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/axfs_devfs"
-documentation = "https://rcore-os.github.io/arceos/axfs_devfs/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/axfs_devfs"
+documentation = "https://arceos-org.github.io/arceos/axfs_devfs/index.html"
 
 [dependencies]
 axfs_vfs = { path = "../axfs_vfs" }

crates/axfs_devfs/src/lib.rs

@@ -1,4 +1,4 @@
-//! Device filesystem used by [ArceOS](https://github.com/rcore-os/arceos).
+//! Device filesystem used by [ArceOS](https://github.com/arceos-org/arceos).
 //!
 //! The implementation is based on [`axfs_vfs`].
 

crates/axfs_ramfs/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "RAM filesystem used by ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/axfs_ramfs"
-documentation = "https://rcore-os.github.io/arceos/axfs_ramfs/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/axfs_ramfs"
+documentation = "https://arceos-org.github.io/arceos/axfs_ramfs/index.html"
 
 [dependencies]
 axfs_vfs = { path = "../axfs_vfs" }

crates/axfs_ramfs/src/lib.rs

@@ -1,4 +1,4 @@
-//! RAM filesystem used by [ArceOS](https://github.com/rcore-os/arceos).
+//! RAM filesystem used by [ArceOS](https://github.com/arceos-org/arceos).
 //!
 //! The implementation is based on [`axfs_vfs`].
 

crates/axfs_vfs/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Virtual filesystem interfaces used by ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/axfs_vfs"
-documentation = "https://rcore-os.github.io/arceos/axfs_vfs/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/axfs_vfs"
+documentation = "https://arceos-org.github.io/arceos/axfs_vfs/index.html"
 
 [features]
 default = []

crates/axfs_vfs/src/lib.rs

@@ -1,4 +1,4 @@
-//! Virtual filesystem interfaces used by [ArceOS](https://github.com/rcore-os/arceos).
+//! Virtual filesystem interfaces used by [ArceOS](https://github.com/arceos-org/arceos).
 //!
 //! A filesystem is a set of files and directories (symbol links are not
 //! supported currently), collectively referred to as **nodes**, which are

crates/axio/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "`std::io`-like I/O traits for `no_std` environment"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/axio"
-documentation = "https://rcore-os.github.io/arceos/axio/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/axio"
+documentation = "https://arceos-org.github.io/arceos/axio/index.html"
 
 [features]
 alloc = []

crates/capability/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Provide basic capability-based security"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/capability"
-documentation = "https://rcore-os.github.io/arceos/capability/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/capability"
+documentation = "https://arceos-org.github.io/arceos/capability/index.html"
 
 [dependencies]
 bitflags = "2.5"

crates/crate_interface/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.1"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Provides a way to define an interface (trait) in a crate, but can implement or use it in any crate."
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/crate_interface"
-documentation = "https://rcore-os.github.io/arceos/crate_interface/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/crate_interface"
+documentation = "https://docs.rs/crate_interface"
 keywords = ["arceos", "api", "macro"]
 categories = ["development-tools::procedural-macro-helpers", "no-std"]
 

crates/driver_block/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Common traits and types for block storage drivers"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/driver_common"
-documentation = "https://rcore-os.github.io/arceos/driver_common/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/driver_common"
+documentation = "https://arceos-org.github.io/arceos/driver_common/index.html"
 
 [features]
 ramdisk = []

crates/driver_common/Cargo.toml

@@ -4,9 +4,9 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Device driver interfaces used by ArceOS"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/driver_common"
-documentation = "https://rcore-os.github.io/arceos/driver_common/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/driver_common"
+documentation = "https://arceos-org.github.io/arceos/driver_common/index.html"
 
 [dependencies]

crates/driver_common/src/lib.rs

@@ -8,7 +8,7 @@
 //! - [`driver_display`][3]: Common traits and types for graphics display drivers.
 //! - [`driver_net`][4]: Common traits and types for network (NIC) drivers.
 //!
-//! [1]: https://github.com/rcore-os/arceos
+//! [1]: https://github.com/arceos-org/arceos
 //! [2]: ../driver_block/index.html
 //! [3]: ../driver_display/index.html
 //! [4]: ../driver_net/index.html

crates/driver_display/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Shiping Yuan <[email protected]>"]
 description = "Common traits and types for graphics device drivers"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/driver_display"
-documentation = "https://rcore-os.github.io/arceos/driver_display/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/driver_display"
+documentation = "https://arceos-org.github.io/arceos/driver_display/index.html"
 
 [dependencies]
 driver_common = { path = "../driver_common" }

crates/driver_net/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>", "ChengXiang Qi <[email protected]>"]
 description = "Common traits and types for network device (NIC) drivers"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/driver_net"
-documentation = "https://rcore-os.github.io/arceos/driver_net/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/driver_net"
+documentation = "https://arceos-org.github.io/arceos/driver_net/index.html"
 
 [features]
 default = []

crates/driver_pci/Cargo.toml

@@ -4,10 +4,10 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Yuekai Jia <[email protected]>"]
 description = "Structures and functions for PCI bus operations"
-license = "GPL-3.0-or-later OR Apache-2.0"
-homepage = "https://github.com/rcore-os/arceos"
-repository = "https://github.com/rcore-os/arceos/tree/main/crates/driver_pci"
-documentation = "https://rcore-os.github.io/arceos/driver_pci/index.html"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/arceos/tree/main/crates/driver_pci"
+documentation = "https://arceos-org.github.io/arceos/driver_pci/index.html"
 
 [dependencies]
 virtio-drivers = "0.7.3"