Skip to content

Update README for Franklin #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2022
Merged

Update README for Franklin #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions CONTRIBUTING.md
View file
Open in desktop

This file was deleted.

31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,35 @@
</p>


This repository contains the source files of [Flux website, fluxml.ai](https://fluxml.github.io/).

Flux is an elegant approach to machine learning. It's a 100% pure-Julia stack, and provides lightweight abstractions on top of Julia's native GPU and AD support. Flux makes the easy things easy while remaining fully hackable.
This repository contains the source files for the [FluxML website, fluxml.ai](https://fluxml.ai). FluxML is a machine learning framework for [Julia](https://julialang.org).

## Contributing

Want to contribute to the FluxML website? Check out the contributing guide: https://github.com/FluxML/fluxml.github.io/blob/main/CONTRIBUTING.md

## Running Locally

1. Install all prerequisites from: https://jekyllrb.com/docs/installation/
2. Run `gem install jekyll bundler`
3. Run `bundle exec jekyll serve`
The website is built with [Franklin.jl](https://franklinjl.org).

First, install Julia then setup your environment.
```
julia --project=.

julia> ]
(fluxml.github.io) pkg> instantiate
```
This will install the necessary packages. It only needs to be done once.

Now, start Julia and serve the page:
```
julia --project=.

julia> using Franklin

julia> serve()
```
This will start a live server that previews the website. You can make edits to the markdown files and see the website update as you save. Please refer to the [Franklin.jl documentation](https://franklinjl.org) for more information on developing a website with Franklin.jl.

### Project structure

Read more here: https://jekyllrb.com/docs/#instructions
Most pages of the website are written as markdown files in the root directory. The `blogposts` directory contains blog posts, and the `tutorialposts` directory contains tutorials.