Skip to content

Commit

Permalink
Merge pull request #2 from cabalism/doc/newcomer
Browse files Browse the repository at this point in the history
Cold explanation
  • Loading branch information
philderbeast authored Sep 6, 2023
2 parents da6b664 + 3627861 commit 5b14ca9
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# <img src="updo-offset.svg" height="80px" />
> A hairstyle and a way of maintaining and upgrading Haskell projects.
Make projects from local packages, dependency versions, source dependency
commits and whatever else you need.
Make projects from packages, versions[^constraints] and
commits[^unpublished-packages].

[^constraints]: A dependency version equality constraint.

### What is a Project?

Updo is good for project packages, constraints, source repository packages and
stackage resolver[^download-stackage-config]. More than this can be added into a
project template.
Updo is good for project packages, constraints[^constraints], source repository
packages[^unpublished-packages] and stackage
resolver[^download-stackage-config]. More than this can be added into a project
template snippet for free-form content.

[^download-stackage-config]: For cabal, the cabal.config will have to be
downloaded to `project-stackage/resolver.config` and then edited to comment
Expand Down Expand Up @@ -69,14 +72,13 @@ using make to generate the projects. What do we want to configure? We don't need
much:

1. A stackage resolver[^download-stackage-config].
2. A list of constraints (package dependencies with their versions).
2. A list of constraints[^constraits].
3. A list of source repository packages, for unpublished[^unpublished-packages]
packages or for unpublished versions of packages.
4. A list of packages.

[^unpublished-packages]: A package not published to hackage or stackage.


All configuration goes into `./project-dhall` (where `.` is the root folder for
your Haskell project) except for the `cabal.config` that we'll need to download
from stackage. Save this file as `project-stackage/lts-m.n.config` using the
Expand Down

0 comments on commit 5b14ca9

Please sign in to comment.