Skip to content

Commit c2d15b4

Browse files
committed
Split between user and developer manual
1 parent 798e700 commit c2d15b4

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

pages/docs.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ custom_js:
1414
* Do not remove this line (it will not be displayed)
1515
{:toc}
1616

17-
# Scafi Documentation
17+
# Background
1818

1919
## Introduction: Aggregate Programming
2020

@@ -59,6 +59,8 @@ In practice, devices sustain the aggregate computation
5959

6060
A code example of round execution in ScaFi is shown in <a href="#building-aggregate-systems">Building Aggregate Systems</a>.
6161

62+
# ScaFi User Manual
63+
6264
## Hello, ScaFi
6365

6466
* Consider the following repository: [https://github.com/scafi/hello-scafi](https://github.com/scafi/hello-scafi)
@@ -70,8 +72,8 @@ As another example, consider the following steps.
7072
**Step 1-A:** SBT
7173

7274
{% highlight scala %}
73-
val scafi_core = "it.unibo.apice.scafiteam" %% "scafi-core" % "0.3.3"
74-
val scafi_simulator_gui = "it.unibo.apice.scafiteam" %% "scafi-simulator-gui" % "0.3.3"
75+
val scafi_core = "it.unibo.scafi" %% "scafi-core" % "0.3.3"
76+
val scafi_simulator_gui = "it.unibo.scafi" %% "scafi-simulator-gui" % "0.3.3"
7577

7678
libraryDependencies ++= Seq(scafi_core, scafi_simulator_gui)
7779
{% endhighlight %}
@@ -527,6 +529,17 @@ Take a look at the following paper for middleware- and deployment-level consider
527529

528530
<div class="bibtex_display" bibtexkey="Viroli2016ubicomp"></div>
529531

532+
# ScaFi Developer Manual
533+
534+
## For project contributors
535+
536+
Contributions to this project are welcome. Some advices:
537+
538+
- As we use [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), use `feature-xxx` branches.
539+
- We recommend *forking* the project, developing your stuff, then contributing back via **pull request** directly from the Web interface.
540+
- Stay in sync with the `develop` branch: pull often from `develop`, so that you don't diverge too much from the main development line.
541+
- Avoid introducing technical debt. In any case, merge requests will be reviewed before merge.
542+
530543
# Something missing?
531544

532545
- If what is missing is of general interest, please [open an Issue in the scafi.github.io repository](https://github.com/scafi/scafi.github.io/issues).

0 commit comments

Comments
 (0)