diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fcf151..992ce01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,4 +26,6 @@ We currently lack a formal process for this. Translations can be submitted via m ## Documentation -We would love assistance in creating a formal documentation process for this project. +Current documentation efforts are focused on adding usable comments in the code itself. +Guides on how to set up and admin a brutaldon instance are likely to follow after that. +Feel free to send in a merge request with other documentation ideas you have! diff --git a/Pipfile b/Pipfile index 09e8b9c..5f57881 100644 --- a/Pipfile +++ b/Pipfile @@ -25,5 +25,8 @@ Django = "~=3.2" django-html_sanitizer = "*" inscriptis = "*" lxml = "*" +uwsgi = "*" +django-debug-toolbar = "*" +gunicorn = "*" [dev-packages] diff --git a/README.md b/README.md index 8e622c5..aedc9ee 100644 --- a/README.md +++ b/README.md @@ -64,5 +64,8 @@ People love screenshots, whatever the project, so here we are. These screenshots * [X] Add support for following, blocking, and muting users. ## Aesthetic - -No automatic page updates: refresh the page to see new toots. No endless scroll: there's a "next page" link. No autocompletion of anything: use another lynx process in another screen window to look things up. UTF8 clean. +Brutaldon seeks to be a minimalist activity-pub client, taking visual and functional inspiration from the web of the 90s. HTML only websites are quite usable actually. Very little CSS and javascript should be used to polish the edges of a powerful and robust tool. + - Brutaldon will function without javascript. + - Brutaldon will function without css. + - No automatic page updates. + - UTF8 clean. diff --git a/brutaldon/context_processors.py b/brutaldon/context_processors.py index 105ccb6..5e3d323 100644 --- a/brutaldon/context_processors.py +++ b/brutaldon/context_processors.py @@ -1,8 +1,12 @@ +# Module for reversing urls. +# In the sense of a reverse proxy I think. from django.urls import reverse - def bookmarklet_url(request): + # takes var request and add a /share/ to the end of the url share_url = request.build_absolute_uri(reverse("share")) + # return the share_url embedded in a string of other stuff. + # not yet sure what that other stuff is for. return { "bookmarklet_url": f"javascript:location.href='{share_url}?url='+encodeURIComponent(location.href)+';title='+encodeURIComponent(document.title)" } diff --git a/brutaldon/forms.py b/brutaldon/forms.py index d348d5f..83c58bd 100644 --- a/brutaldon/forms.py +++ b/brutaldon/forms.py @@ -1,6 +1,13 @@ +# The Forms modules supplies tools for http get and post, +# and building the