Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
equation314 committed Jul 19, 2024
1 parent a0e0867 commit 062b547
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# arceos-apps

[![CI](https://github.com/arceos-org/arceos-apps/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/arceos-org/arceos-apps/actions/workflows/build.yml)
[![CI](https://github.com/arceos-org/arceos-apps/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/arceos-org/arceos-apps/actions/workflows/test.yml)

Example apps for [ArceOS](https://github.com/arceos-org/arceos).

## List of Rust Apps

| App | `axstd` features | Extra modules | Description |
|-|-|-|-|
| [helloworld](rust/helloworld/) | | | A minimal app that just prints a string |
| [exception](rust/exception/) | | | Exception handling test |
| [memtest](rust/memtest/) | alloc | axalloc | Dynamic memory allocation test |
| [display](rust/display/) | display | axdisplay | Graphic/GUI test |
| [yield](rust/task/yield/) | multitask | axalloc, axtask | Multi-threaded yielding test |
| [sleep](rust/task/sleep/) | multitask, irq | axalloc, axtask | Thread sleeping test |
| [parallel](rust/task/parallel/) | alloc, multitask | axalloc, axtask | Parallel computing test (to test synchronization & mutex) |
| [priority](rust/task/priority/) | alloc, multitask | axalloc, axtask | Task priority test |
| [tls](rust/task/tls/) | alloc, multitask, tls | axalloc, axtask | Thread local storage test |
| [shell](rust/fs/shell/) | alloc, fs | axalloc, axdriver, axfs | A simple shell that responds to filesystem operations |
| [httpclient](rust/net/httpclient/) | net | axalloc, axdriver, axnet | A simple client that sends an HTTP request and then prints the response |
| [udpserver](rust/net/udpserver/) | net | axalloc, axdriver, axnet | A single-threaded echo server using UDP protocol |
| [echoserver](rust/net/echoserver/) | alloc, multitask, net | axalloc, axdriver, axnet, axtask | A multi-threaded TCP server that reverses messages sent by the client |
| [httpserver](rust/net/httpserver/) | alloc, multitask, net | axalloc, axdriver, axnet, axtask | A multi-threaded HTTP server that serves a static web page |
| [bwbench](rust/net/bwbench/) | net | axalloc, axdriver, axnet | Network bandwidth benchmark |

## List of C Apps

| App | `axlibc` features | Extra modules | Description |
|-|-|-|-|
| [helloworld](c/helloworld/) | | | A minimal C app that just prints a string |
| [memtest](c/memtest/) | alloc | axalloc | Dynamic memory allocation test in C |
| [pthread_basic](c/pthread/basic/) | alloc, multitask | axalloc, axtask | Basic pthread test (create, join, exit, and mutex) |
| [pthread_parallel](c/pthread/parallel/) | alloc, multitask | axalloc, axtask | Parallel computing test in C |
| [pthread_sleep](c/pthread/sleep/) | alloc, multitask, irq | axalloc, axtask | Thread sleeping test in C |
| [pthread_pipe](c/pthread/pipe/) | alloc, multitask, pipe | axalloc, axtask | Multi-thread communication using pipe |
| [httpclient](c/httpclient/) | alloc, net | axalloc, axdriver, axnet | A simple client that sends an HTTP request and then prints the response |
| [udpserver](c/udpserver/) | alloc, net | axalloc, axdriver, axnet | A single-threaded echo server using UDP protocol |
| [httpserver](c/httpserver/) | alloc, net | axalloc, axdriver, axnet | A single-threaded HTTP server that serves a static web page |
| [sqlite3](c/sqlite3/) | fp_simd, alloc, fs | axalloc, axdriver, axfs | Porting of [SQLite3](https://sqlite.org/index.html) |
| [iperf](c/iperf/) | fp_simd, alloc, fs, net, select | axalloc, axdriver, axfs, axnet | Porting of [iPerf3](https://iperf.fr/) |
| [redis](c/redis/) | fp_simd, alloc, irq, multitask, fs, net, pipe, epoll | axalloc, axdriver, axtask, axfs, axnet | Porting of [Redis](https://redis.io/) |

0 comments on commit 062b547

Please sign in to comment.