diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ec8b9598..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,31 +0,0 @@ -# Contributing - -Thank you for taking the time to think about contributing to the FluxML website. If you want to make a change, please propose it here. We welcome all contributions. If you are new to Open Source and are unsure how to get started with the mechanics of making a contribution, check out this guide: https://guides.github.com/activities/hello-world/ - -## Style Change - -If you are making a stylistic change to the FluxML website, please include screenshots of what the proposed changes will look like. This will expedite the approval process. - -## Blog Posts and Tutorials - -We welcome new blog posts / tutorials about Flux or FluxML ecosystem wide usecases. Please see this Pull Request for an example of creating a new blog post: https://github.com/FluxML/fluxml.github.io/pull/66 and this one: https://github.com/FluxML/fluxml.github.io/pull/87 for examples of creating a tutorial. - -## Building the Site Locally - -Before building this site on your local machine, you need to install the following: - -* [Jekyll](https://jekyllrb.com/docs/installation/) -* [Ruby](https://www.ruby-lang.org/en/documentation/installation/) -* [Bundler](https://bundler.io/) - -To build the Flux site locally: - -1. Clone this repo. -1. Navigate to your local copy. -1. Run the site locally: - - ``` - $bundle exec jekyll serve - ``` - ->Note: To preview the Flux site, go to `http://localhost:4000`. diff --git a/README.md b/README.md index 96dafc13..1a958f47 100755 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@

-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 @@ -13,8 +11,27 @@ Want to contribute to the FluxML website? Check out the contributing guide: http ## 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.