Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.58 KB

Start.md

File metadata and controls

60 lines (42 loc) · 2.58 KB
Raw

Introduction

This document provides instructions on how to set up and run the xMind project. After building the project, you'll find the following key folders and files:

  • Config: Contains configuration files, including config.yml and config.xml.
  • Examples: Includes example agents and reference files.
  • Service: The webserver directory containing the service xLang code (main.x) and other web pages.
  • xMind: The executable to start the xMind application.

Prerequisites

Ensure that all necessary dependencies are installed and that you have successfully built the project. The key executable to start the application is xMind.

Configuration

config.yml

The config.yml file contains critical configurations for the xMind application. Below is a summary of the key sections:

  • WebServer:

    • Port: The port on which the web server will run (default: 9901).
    • ServiceEntry: Path to the main xLang code for the web server (../Service/main.x).

  • RootAgents:

    • List of agents to be registered and displayed in the chat page's Agent/Model choose list.
    • Example: 
      RootAgents:
   - name: simple
     file: ../Examples/Simple/simple.yml
   - name: QAJudge
     file: ../Examples/Simple/two_simples.yml

Running xMind

  1. Start xMind: Execute the xMind binary from the out/bin directory.

    ./xMind

  2. Access the Web Interface:

    • Open a web browser and navigate to http://localhost:9901 to access the index page.
    • If accessing from another machine, replace localhost with the IP address of the machine running xMind.

  3. Using RootAgents:

    • The RootAgents defined in config.yml will appear in the chat page under the Agent/Model choose list, allowing you to interact with the registered agents.

Folder Structure

  • Config: Contains configuration files such as config.xml and config.yml.
  • Examples: Holds example agents that serve as references for creating and configuring your agents.
  • Service: Contains the webserver code and pages, including main.x, which serves as the service entry point.

Additional Information

  • Service Folder: The Service folder includes the webserver's xLang code (main.x) and associated web pages.
  • Logs: Log files are stored in the Logs directory for troubleshooting and monitoring.

This should cover the essentials needed to start and run the xMind project successfully. If you encounter any issues, please refer to the logs in the Logs directory for more detailed information.