Skip to content

Commit ac164db

Browse files
Temporarily convert README to all Markdown (#187)
We'd love to highlight NuMojo on the Modular website, but unfortunately we don't currently support parsing HTML from READMEs. I'm wondering if you'd be open to temporarily converting the README for the project to all Markdown as I've done in this PR – this will allow us to highlight your project, and we'll work on getting support for parsing HTML in READMEs in the meantime. @shivasankarka @forfudan @MadAlex1997 @sandstromviktor --------- Co-authored-by: ZHU Yuhao 朱宇浩 <[email protected]>
1 parent 13bc54b commit ac164db

File tree

2 files changed

+24
-60
lines changed

2 files changed

+24
-60
lines changed

README.MD

Lines changed: 24 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,36 @@
1-
<a name="readme-top"></a>
2-
<!-- add these later -->
3-
<!-- [![MIT License][license-shield]][] -->
4-
5-
<div align="center">
6-
<a href="">
7-
<img src="./assets/numojo_logo.png" alt="Logo" width="350" height="350">
8-
</a>
9-
10-
<h1 align="center" style="font-size: 3em; color: white; font-family: 'Avenir'; text-shadow: 1px 1px orange;">NuMojo</h1>
11-
12-
<p align="center">
13-
NuMojo is a library for numerical computing in Mojo 🔥 similar to NumPy, SciPy in Python.
14-
<br />
15-
<!-- when we create docs -->
16-
<div style="font-family: 'Arial'; border: 1px solid black; padding: 5px;">
17-
<a href="https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo-Examples-and-Benchmarks/blob/main/docs/README.md"><strong>Explore the docs» </strong></a> &nbsp; &nbsp;
18-
<a href="./docs/changelog.md"><strong>Changelog» </strong></a> &nbsp; &nbsp;
19-
<a href="https://discord.com/channels/1149778565756366939/1149778566603620455" ><strong>Check out our Discord» </strong></a>
20-
</div>
21-
<br />
22-
<div style="font-family: 'Arial'; border: 1px solid black; padding: 5px;">
23-
<a href="./docs/readme_zhs.md"><strong>中文·简» </strong></a> &nbsp;
24-
<a href="./docs/readme_zht.md"><strong>中文·繁» </strong></a> &nbsp;
25-
<a href="./docs/readme_jp.md"><strong>日本語» </strong></a>
26-
</div>
27-
<!-- <a href="./docs/readme_kr.md"><strong>한국어 문서» </strong></a> -->
28-
<!-- <br /> -->
29-
<!-- <br /> -->
30-
<!-- <a href="">View Demo</a>
31-
·
32-
<a href="">Report Bug</a>
33-
·
34-
<a href="">Request Feature</a> -->
35-
</p>
36-
</div>
37-
38-
<details>
39-
<summary>Table of Contents</summary>
40-
<ol>
41-
<li>
42-
<a href="#about-the-project">About The Project</a>
43-
<ul>
44-
<li><a href="#what-numojo-is"> What NuMojo is </a></li>
45-
<li><a href="#what-numojo-is-not">What NuMojo is not</a></li>
46-
</ul>
47-
</li>
48-
<li><a href="#goals">Goals</a></li>
49-
<li><a href="#usage">Usage</a></li>
50-
<li><a href="#how-to-install">How to install</a></li>
51-
<li><a href="#contributing">Contributing</a></li>
52-
<li><a href="#warnings">Warnings</a></li>
53-
<li><a href="#license">License</a></li>
54-
<li><a href="#acknowledgments">Acknowledgments</a></li>
55-
<li><a href="#Contributors">Contributors</a></li>
56-
</ol>
57-
</details>
1+
# NuMojo
2+
3+
![logo](./assets/numojo_logo_360x360.png)
4+
5+
NuMojo is a library for numerical computing in Mojo 🔥 similar to NumPy, SciPy in Python.
6+
7+
**[Explore the docs»](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo-Examples-and-Benchmarks/blob/main/docs/README.md)** **[Changelog»](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/docs/changelog.md)** **[Check out our Discord»](https://discord.com/channels/1149778565756366939/1149778566603620455)**
8+
9+
**[中文·简»](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/docs/readme_zhs.md)** **[中文·繁»](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/docs/readme_zht.md)** **[日本語»](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/docs/readme_jp.md)**
10+
11+
**Table of Contents**
12+
13+
1. [About The Project](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#about-the-project)
14+
2. [Goals](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#goals)
15+
3. [Usage](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#usage)
16+
4. [How to install](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#how-to-install)
17+
5. [Contributing](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#contributing)
18+
6. [Warnings](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#warnings)
19+
7. [License](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#license)
20+
8. [Acknowledgements](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#acknowledgments)
21+
9. [Contributors](https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/blob/main/README.MD#Contributors)
5822

5923
## About the project
6024

61-
### What NuMojo is
25+
***What NuMojo is***
6226

6327
NuMojo intends to capture a wide swath of numerics capability present in the Python packages NumPy, SciPy, and Scikit.
6428

6529
NuMojo intends to try and get the most out of the capabilities of Mojo including vectorization, parallelization, and GPU acceleration (once available). Currently, NuMojo extends (most of) the standard library math functions to work on array inputs.
6630

6731
We intend NuMojo to be a building block for other Mojo packages that need fast math under the hood without the added weight of a ML back and forward propagation system
6832

69-
### What NuMojo is not
33+
***What NuMojo is not***
7034

7135
NuMojo is not a machine learning library, it will never include back-propagation in the base library.
7236

@@ -257,4 +221,4 @@ Built in native [Mojo](https://github.com/modularml/mojo) which was created by [
257221

258222
<a href="https://github.com/Mojo-Numerics-and-Algorithms-group/NuMojo/graphs/contributors">
259223
<img src="https://contrib.rocks/image?repo=Mojo-Numerics-and-Algorithms-group/NuMojo" />
260-
</a>
224+
</a>

assets/numojo_logo_360x360.png

35.3 KB
Loading

0 commit comments

Comments
 (0)