Comments (3)
@sjbcastro Thank you for your suggestion. We are working on the improvement of documentation. Those items are noted and will be the part of this update.
@gmajan, Fyi.
from flint.
@mfellows @gmajan @aornugent
I am Sree Vidhya, an Outreachy applicant. I have been looking at the FLINT repository and getting an understanding of the FLINT Codebase. I found README.md has some issues
The things I have updated (Updated README.md file)
- Website of an URL linked has been expired - I have removed the URL
- The FAQ page URL is wrong (It is redirecting to the error 404 page) - I have updated with the correct URL
Things I will work on
- The beginners who are new to the Moja repository and are willing to install the development environment have some set of commands present in the README.md file. But there are some important steps like in CMake installation, we need to "Add CMake to the system PATH for all users" which if not done will cause an error at the end.
I will update such points in the README.md file - I will also update the "How to use FLINT?" with youtube video URL "FLINT Core on Visual Studio 2019" from Moja global channel this would help the beginners to follow the steps easily
Can you assign me this issue? I would like to work on it
from flint.
Thanks @vidhya001 - just make sure you work off the develop branch, it might be more up to date.
from flint.
Related Issues (20)
- Add video link, Remove dead links, Reduce grammatical errors. HOT 2
- Fix tables in Module wiki HOT 11
- Known issues section for FLINT installation. HOT 3
- Some links in the FLINT document is not working. HOT 11
- Understanding the reason for an instruction HOT 6
- Making FLINT understandable to Users and New Contributors HOT 2
- BLD: `Dockerfile.base.ubuntu.18.04` build currently fails HOT 1
- improving formatting of last section of readme HOT 2
- Update license of FLINT to latest version HOT 1
- extendable land unit area concept. HOT 7
- Add Welcome Bot to create an inclusive environment for new contributors HOT 1
- Repository Missing Description HOT 1
- Error in setting up FLINT
- Update version numbers for CMake HOT 3
- Docker build command for base container does not work HOT 3
- Updation of commands to install vcpkg packages in README.md HOT 1
- Error in installing FLINT HOT 5
- Missing Outputs of Modules under Module Science in Wiki Section.
- Add links to installation videos and fix some links in the README.md of the develop branch HOT 1
- Adding images to the wiki section HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from flint.