schtobia/flex
1
0
Fork 0
Code Issues Pull requests Activity

Add v3 notes

Browse source
This commit is contained in:
Alexandre Vicenzi 2023-03-31 23:51:41 +02:00
parent 426452cc82
commit 78a57ba120
1 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,12 +1,27 @@
# Flex [![Build Status](https://travis-ci.org/alexandrevicenzi/Flex.svg?branch=master)](https://travis-ci.org/alexandrevicenzi/Flex)
# Flex
The minimalist [Pelican](http://blog.getpelican.com/) theme.
## Notes
## Flex 3.0 and upcoming breaking changes
- If you have questions open an issue
- The theme is not under huge development anymore, it's stable and has a lot of features already
- If you want a [Hugo](https://gohugo.io/) theme check out [Soho](https://github.com/alexandrevicenzi/soho)
Flex 2.6 will be the last release without breaking changes.
Flex 3.0 is under development and will introduce breaking changes.
The breaking changes will include:
* Removal of deprecated plugins and integrations
* Removal and renaming of configuration variables
* Removal of Less.js and Gulp.js
* Refactoring of multiple templates
Flex has grown beyond expectation over the last few years and is hard to maintain and accept new features.
You can check the current progress in the `v3` branch.
New features won't be accepted unless submited to `v3` branch, bug fixes will still be accepted in the `master` branch.
Once 2.6 is out, the `v3` branch will be merged into `master`.
## Features
@ -55,7 +70,7 @@ The minimalist [Pelican](http://blog.getpelican.com/) theme.
The best way to install is over [pelican-themes](https://github.com/getpelican/pelican-themes).
The alternative way is to clone this repository. The `master` branch is stable and is safe to checkout, but I would recommend you to checkout a tag branch.
The alternative way is to clone this repository and checkout a tag branch.
## Documentation
@ -73,8 +88,8 @@ The code is available in this project under `docs` folder.
## Contributing
**ALWAYS** open an issue before sending a PR.
Discuss the problem/feature that you want to code.
After discussing, send a PR with your changes.
Discuss the problem/feature that you want to solve.
If things make sense, send a PR with your changes.
As always, if you want something that only makes sense to you, fork Flex and create a new theme.