🍃 Larch 🍃

Opis dla każdego

Larch jest składającym się z modułów systemem służącym do wspomagania dowodzenia. W tym projekcie skupiamy się na poprawie metod dydaktyki logiki chcąc doprowadzić do możliwości dowodzenia tylko i wyłącznie myszką. Aktualnie wspieramy tabele analityczne KRZ (sygnowane i niesygnowane) oraz oferujemy konsolową implementację rachunku sekwentów.

The truth is only one click away!

Opis dla niektórych

Larch jest silnikiem wspomagania dowodzenia opartym na silnej implementacji Plugin Oriented Programming. Projekt rozwijany jest w celach dydaktycznych - aby odciążyć studentów od przepisywania zdań oraz rozpisywania reguł, dając tym samym możliwość skupienie się na strategii dowodu. Zaawansowanym użytkownikom oferowana jest możliwość tworzenia systemów dowodzenia, parserów, form wydruku, podpowiedzi, a nawet interfejsów.

Instalacja

Windows

Upewnij się, że masz zainstalowany co najmniej Python 3.9
Pobierz release (larch.zip) programu z tego miejsca. Zalecamy wybór wersji GUI, gdyż uruchamia się ona domyślnie w formie aplikacji webowej.
Wypakuj zawartość.
Uruchom aplikację przez plik .cmd, lub .pyz.
Nalej sobie bezalkoholowego szampana, gdy Larch pobiera automatycznie wszystkie potrzebne pliki.

Mac

Upewnij się, że masz zainstalowany co najmniej Python 3.9
Pobierz release (larch.zip) programu z tego miejsca. Zalecamy wybór wersji GUI, gdyż uruchamia się ona domyślnie w formie aplikacji webowej.
Wypakuj zawartość.
Uruchom plik install.sh w terminalu (w katalogu z plikami programu). Nada on plikom uprawnienia do bycia wykonywanym.
Program możesz uruchamiać klikając dwukrotnie plik larch.command, wpisując w terminalu (w katalogu z plikami programu) sh larch.sh, bądź uruchamiając ten skrypt w dowolny inny sposób.
Nalej sobie bezalkoholowego szampana, gdy Larch pobiera automatycznie wszystkie potrzebne pliki.

Linux

Upewnij się, że masz zainstalowany co najmniej Python 3.9
Pobierz release (larch.zip) programu z tego miejsca. Zalecamy wybór wersji GUI, gdyż uruchamia się ona domyślnie w formie aplikacji webowej.
Wypakuj zawartość.
Uruchom plik install.sh w terminalu (w katalogu z plikami programu). Nada plikom uprawnienia do bycia wykonywanym.
Program możesz uruchamiać wpisując w terminalu (w katalogu z plikami programu) larch.sh, bądź uruchamiając ten skrypt w dowolny inny sposób.
Nalej sobie bezalkoholowego szampana, gdy Larch pobiera automatycznie wszystkie potrzebne pliki.

Użycie i uruchamianie

Uruchamianie

Powtórz kroki od 5. w instrukcji instalacji. Wersja GUI dla bezpieczeństwa wymaga dostępu do internetu, aby przeprowadzać redownload wszystkich potrzebnych plików. W razie potrzeby możemy Ci jednak dostarczyć wersję nie korzystającą z niego.

Użycie GUI

Interfejs jest dość prosty ;) Kilka podpowiedzi:

Możesz zmieniać gałęzie klikając na ich liście.
Możesz rozkładać formuły w ramach różnych gałęzi przez kliknięcie na liść i wybór formuły do rozłożenia.
Musisz kliknąc regułę dowodzenia.

Użycie CLI

Najważniejsze komendy dostępne w interfejsie:

? przywołuje listę wszystkich komend, [komenda]? przywołuje pomoc dla danej komendy,
prove [zdanie] rozpoczyna dowód; możesz go opuścić z pomocą leave,
w trakcie dowodzenia możesz używać komendy use [reguła] [kontekst] do użycia reguły,
listę dostępnych reguł znajdziesz w podpowiedziach podczas wpisywania oraz pod komendą get rules, która poda także informacje o wymaganiach danej reguły (na przykład poinformuje o potrzebie podania Sentence ID, czyli numeru zdania w gałęzi),
w każdym momencie dowodu znajdujesz się na pewnej gałęzi, zmieniać możesz je komendą jump [nazwa gałęzi/>/<], lub next (ta przeniesie Cię do następnej otwartej gałęzi),
swój dowód możesz wyświetlić w łatwiejszej do zrozumienia formie z pomocą komendy get tree, gałąź możesz wyświetlić komendą get branch,

Larch oferuje też wewnętrzny system pluginów, ich listę możesz wyświetlić komendą plugin list [nazwa gniazda/all]. Pluginy możesz zmieniać komendą plugin switch [gniazdo/aktualnie podłączony plugin] [nowy plugin].

Contributing

Zapraszamy do zapoznania się z naszą dokumentacją na ten temat!

Zgłaszanie błędów

Błędy (oraz propozycje) można zgłaszać za pomocą Notion oraz w formularzu. Na powyższej stronie możesz znaleźć przycisk New. Powinna wyświetlić Ci się pusta strona z możliwością wyboru wzoru. Wybierz odpowiedni i wypełnij formularz. Postaraj się wyjaśnić jak najdokładniej, co się stało - każdy szczegół może okazać się przydatny! Jeśli masz pomysł, co mogło spowodować błąd, możesz spróbować samemu go naprawić!

Bardzo przydatne jest dla nas dołączenie crash reportu, który możesz znaleźć w folderze crashes. Chętnie przyjmiemy też plik config.json!

Tworzenie pluginów

Projekt Larch został utworzony tak, aby umożliwić każdej chętnej osobie tworzenie autorskich metod dowodzenia, formatów wydruku, formatów zapisów, czy interfejsów.

Możesz skopiować wzór pluginu z pomocą komendy plugin gen [nazwa gniazda] [nazwa pluginu]. Znajdziesz w nim zestaw wzorów funkcji, które wymagane są od danego pluginu. Type hinting podpowie Ci, co dany plugin przyjmuje, a co zwraca dana funkcja. Skorzystaj z docstringów wewnątrz kodu oraz dokumentacji. Nie bój się z nami kontaktować - nie ma głupich pytań, są tylko głupie filmiki w internecie!

Dołącz do drzewnej drużyny

Larch jest projektem potrzebującym ludzi z szerokiego spektrum umiejętności. Potrzebujemy zarówno logików, programistów, testerów, jak i projektantów oraz grafików. W związku z tym chętnie przyjmujemy każdego do naszej społeczności - jeżeli uważasz, że możesz nam się przydać, to prawdopodobnie tak jest!

Jeśli chcesz się zaangażować, możesz skontaktować się z dowolnym z autorów.

Autorzy

Jakub Dakowski (@PogromcaPapai) - 👑 Benevolent dictator for life 👑
Barbura Adamska - Chief Bzdury Officer 📈
Robert Szymański (@rsxxi) - PM/UX unicorn 🦄
Ola Draszewska (@nerdolo) - Confused coder 👾
Łukasz Abramowicz (@ghostbuster265) - I arise from depths of my parents basement to code or sth 🐙
Dominika Juszczak (@antykwariat) - frontend develoops i did it again 🦎

Oraz wszyscy, którzy bacznie przyglądali się rozwojowi aplikacji.

Autorzy pluginów

Michał Gajdziszewski - algorytm printujący w actual_tree
Aleksander Kiryk - algorytm generowania formuł

Larch-Team / Larch