Skip to content

Commit

Permalink
Merge pull request #28 from Zone01-Kisumu-Open-Source-Projects/featur…
Browse files Browse the repository at this point in the history
…e/docs

refactor(docs): Move README and license files from the root to docs dir
  • Loading branch information
kh3rld authored Jan 14, 2025
2 parents f912bbd + c6b6bfb commit b853ead
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 16 deletions.
28 changes: 28 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
BSD 3-Clause License

Copyright (c) 2024, Zone01-Kisumu-Open-Source-Projects

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 changes: 22 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,63 @@
## **Kisumu Programming Language**

Welcome to **Kisumu**, a modern statically-typed programming language inspired by Python, Go, Rust, and Lua. Kisumu is designed for simplicity, performance, and scalability, making it an excellent choice for both beginner programmers and experienced developers building robust, efficient applications.

Welcome to **Kisumu**, a modern statically-typed programming language inspired by Go, Rust, and Python. Kisumu is designed for simplicity, performance, and scalability, making it an excellent choice for both beginner programmers and experienced developers building robust, efficient applications.

### **Key Features**

- **C-style Syntax**: Easy-to-read and familiar syntax for developers.
- **Statically Typed**: Ensures type safety and performance.
- **First-Class Concurrency**: Powerful models like goroutines, actors, and channels.
- **Extensibility**: Modular structure with packages for scalable codebases.
- **Garbage Collection**: Automatic memory management for safety and ease.
- **Interoperability**: FFI support for integration with C, Go, and more.


### **Getting Started**

#### **1. Install Kisumu**

Installation instructions will be provided closer to the public release. Stay tuned for updates.

#### **2. Write Your First Program**

```ksm
fn main() {
print("Hello, Kisumu!")
}
```

#### **3. Explore the Documentation**

Dive deeper into Kisumu's features and capabilities:
- [Introduction](docs/introduction/overview.md)
- [Design Philosophy](docs/introduction/vision.md)
- [Quick Start Guide](docs/introduction/quick_start.md)

#### **4. Try the Examples**
- [Introduction](docs/README.md)
- [Design Philosophy](docs/specs/architecture.md)
- [Quick Start Guide](docs/development/setup.md)

<!-- #### **4. Try the Examples**
Explore working examples:
- [Hello World](examples/hello_world.ksm)
- [Concurrency](examples/concurrency_example.ksm)
- [Modules](examples/modules_example.ksm)

- [Modules](examples/modules_example.ksm) -->

### **Contributing to Kisumu**
We welcome contributions to make Kisumu even better!
Learn how to get involved by reading our [Contribution Guidelines](CONTRIBUTING.md).

We welcome contributions to make Kisumu even better!
Learn how to get involved by reading our [Contribution Guidelines](docs/development/contribution-guidelines.md).

### **Community and Feedback**
Join the growing Kisumu community:
- Share feedback in [docs/community/feedback.md](docs/community/feedback.md).
- Check out our [FAQ](docs/community/faq.md) for common questions.

Join the growing Kisumu community:

- Share feedback in [docs/community/feedback.md](docs/community/communication.md).
- Check out our [Code Of Conduct](docs/community/code-of-conduct.md).

### **License**
This project is licensed under the BSD 3-Clause License. See the [LICENSE](/LICENSE) file for details.

This project is licensed under the BSD 3-Clause License. See the [LICENSE](/LICENSE) file for details.

## :clap: Supporters
## :clap: Supporters

[![Stargazers repo roster for @Zone01-Kisumu-Open-Source-Projects/kisumu-lang](https://reporoster.com/stars/dark/Zone01-Kisumu-Open-Source-Projects/kisumu-lang)](https://github.com/Zone01-Kisumu-Open-Source-Projects/kisumu-lang/stargazers)

Expand Down

0 comments on commit b853ead

Please sign in to comment.